// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *
// Copyright (c) 2011, Dr. Masroor Ehsan
// All rights reserved.
// 
// Redistribution and use in source and binary forms, with or without
// modification, are permitted provided that the following conditions are met:
//     * Redistributions of source code must retain the above copyright
//       notice, this list of conditions and the following disclaimer.
//     * Redistributions in binary form must reproduce the above copyright
//       notice, this list of conditions and the following disclaimer in the
//       documentation and/or other materials provided with the distribution.
//     * Neither the name of the author nor the
//       names of its contributors may be used to endorse or promote products
//       derived from this software without specific prior written permission.
// 
// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
// ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
// WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
// DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY
// DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
// (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
// LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
// ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
// SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
// 
// $Author:$
// $Id:$
// $Rev:$
// * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * *

using MaxTrader.Core;

namespace MaxTrader.BusinessObjects
{
    public abstract class AbstractTransaction : Entity
    {
        /// <summary>
        ///   Portfolio to which this transaction belongs
        /// </summary>
        public virtual Portfolio Portfolio { get; set; }

        /// <summary>
        ///   Cash or Share transaction
        /// </summary>
        public virtual TransactionType Type { get; protected set; }

        /// <summary>
        ///   Accumulate, withdraw, reduce, dividend etc.
        /// </summary>
        public virtual TransactionCategory Category { get; set; }

        public virtual TradingDate Date { get; set; }

        /// <summary>
        ///   Total amount of the transaction. In case of stock transactions 
        ///   it represents (NumberOfShares * Price)
        /// </summary>
        public virtual Money Amount { get; set; }

        /// <summary>
        ///   The cost of the trade if this transaction was a share transaction
        /// </summary>
        public virtual Money TradeCost { get; set; }
    }
}